/*
 * mana (library)
 * Copyright (c) 2003 Shun Moriya <shun@mnu.sakura.ne.jp>
 *
 * The MIT License
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/*!
 * @file
 * @brief	mana_hashクラスに関するヘッダーファイル
 *
 * このファイルはmana_hashクラスに関係するヘッダーファイルです。
 * mana_hashクラスは文字列をキーにした連想配列に関数操作を行ないます。
 *
 * @author	Shun Moriya <shun@mnu.sakura.ne.jp>
 */

#if !defined(___MANA_HASH_H___)
#define ___MANA_HASH_H___

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif

#define MANA_HASH_TABLE_SIZE	(31)	/*!< @brief ハッシュテーブルサイズ(素数が好ましい) */

/*! @brief mana_hash_table の双方向リンク */
typedef struct mana_hash_table_link
{
	struct mana_hash_table_link* previousChain;	/*!< @brief 前の mana_hash_table へのポインタ */
	struct mana_hash_table_link* nextChain;		/*!< @brief 次の mana_hash_table へのポインタ */
}mana_hash_table_link;

/*! @brief mana_hashクラスのハッシュテーブル */
typedef struct mana_hash_table
{
	mana_hash_table_link chain;		/*!< @brief mana_hash_table への双方向リンク */
	struct mana_hash_table* next;	/*!< @brief 次のハッシュテーブルへのポインタ */
	const char* name;				/*!< @brief キー */
	void* data;						/*!< @brief 値 */
} mana_hash_table;

/*!
 * @brief	mana_hashクラス
 * mana_hashクラスは文字列をキーにした連想配列を表しています。
 *
 * C++でいうところのメンバー変数ですが、C言語なので全てpublicになっています。
 * 操作用の関数を用意しているので、それらの関数を利用して操作してください。
 */
typedef struct mana_hash
{
	/*! @brief ハッシュチェーン(反復用キャッシュ) */
	mana_hash_table_link chain;
	/*! @brief ハッシュチェーン(最後のアクセス) */
	mana_hash_table* last;
	/*! @brief ハッシュテーブル */
	mana_hash_table* table[MANA_HASH_TABLE_SIZE];
}mana_hash;

/*! @brief mana_hashクラスの反復子 */
typedef struct mana_hash_iterator
{
	mana_hash_table* iterator;			/*!< @brief 参照中のmana_hash_table */
}mana_hash_iterator;

/*! @brief mana_hash オブジェクトの生成 */
extern mana_hash* mana_hash_create(void);

/*! @brief mana_hash オブジェクトの破棄 */
extern void mana_hash_destroy(mana_hash* self);

/*! @brief mana_hash オブジェクトの初期化 */
extern void mana_hash_initialize(mana_hash* self);

/*! @brief mana_hash オブジェクトの開放 */
extern void mana_hash_finalize(mana_hash* self);

/*! @brief mana_hash オブジェクトの比較 */
extern int mana_hash_compare(const mana_hash* self, const mana_hash* other);

/*! @brief mana_hash オブジェクトのコピー */
extern void mana_hash_duplicate(mana_hash* self, const mana_hash* source);

/*! @brief mana_hash オブジェクトのクリア */
extern void mana_hash_clear(mana_hash* self);

/*! @brief データを消去 */
extern void mana_hash_erase(mana_hash* self, const char* name);

/*! @brief データの存在テスト */
extern int mana_hash_test(mana_hash* self, const char* name);

/*! @brief データを取得 */
extern void* mana_hash_get(mana_hash* self, const char* name);

/*! @brief データを設定 */
extern void* mana_hash_set(mana_hash* self, const char* name, void* data);

/*! @brief イテレータ（反復子）の巻き戻し */
extern void mana_hash_iterator_rewind(mana_hash_iterator* iterator);

/*! @brief イテレータ（反復子）を次へ移動 */
extern int mana_hash_iterator_hash_next(const mana_hash* self, mana_hash_iterator* iterator);

/*! @brief イテレータ（反復子）が指すハッシュのキーを取得 */
extern const char* mana_hash_iterator_get_name(const mana_hash_iterator* iterator);

/*! @brief イテレータ（反復子）が指すハッシュの値を取得 */
extern void* mana_hash_iterator_get_value(const mana_hash_iterator* iterator);

#if defined(_LANGUAGE_C_PLUS_PLUS) || defined(__cplusplus) || defined(c_plusplus)
}
#endif

#endif
